package com.clementheliou.cheliou.dal.model.photo.enumeration;

/**
 * Enumeration that represents the availables directions for a photography.
 * 
 * @author Clément HELIOU (clement.heliou@gmail.com)
 * @since 1.0
 */
public enum Direction {

	/**
	 * The landscape direction.
	 * 
	 * @author Clément HELIOU (clement.heliou@gmail.com)
	 * @since 1.0
	 */
	LANDSCAPE("enum_direction_landscape"),

	/**
	 * The portrait direction.
	 * 
	 * @author Clément HELIOU (clement.heliou@gmail.com)
	 * @since 1.0
	 */
	PORTRAIT("enum_direction_portrait"),
	
	/**
	 * The square direction.
	 * 
	 * @author Clément HELIOU (clement.heliou@gmail.com)
	 * @since 1.0
	 */
	SQUARE("enum_direction_square");

	/**
	 * The key of the enum value; it will be used for translation.
	 * 
	 * @author Clément HELIOU (clement.heliou@gmail.com)
	 * @since 1.0
	 */
	private String labelKey;

	/**
	 * Constructor from the label key.
	 * 
	 * @author Clément HELIOU (clement.heliou@gmail.com)
	 * @param labelKey the label key to be used.
	 * @since 1.0
	 */
	private Direction(final String labelKey) {
		this.labelKey = labelKey;
	}

	/*
	 * Getters & setters.
	 */

	public String getLabelKey() {
		return labelKey;
	}

	public void setLabelKey(String labelKey) {
		this.labelKey = labelKey;
	}
}
